home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #3 / Amiga Plus CD - 2002 - No. 03.iso / AmigaPlus / Tools / Development / source-highlight-1.6.2 / share / doc / source-highlight / INSTALL < prev    next >
Encoding:
Text File  |  2003-02-08  |  8.1 KB  |  197 lines
  1. Basic Installation
  2. ==================
  3.  
  4.     For more information specific to this package, please read the README
  5. file. This source code distribution  is autoconfiguring and you should be 
  6. able to compile it and install it without manual interventions such as 
  7. editing Makefiles, configuration files, and so on. These are generic 
  8. instructions for people who are not familiar with installing autoconfiguring
  9. software.
  10.  
  11. The simplest way to compile this package is to enter the source code
  12. main directory and do the following:
  13.    
  14.   1. Configure the source code by typing:
  15.         % sh ./configure
  16.  
  17.      If you're planning to install the package into your home directory
  18.      or to a location other than `/usr/local' then add the flag
  19.      `--prefix=PATH' to `configure'. For example, if your home directory  
  20.      is `/home/luser' you can configure the package to install itself there
  21.      by invoking:
  22.         % sh ./configure --prefix=/home/luser
  23.      
  24.      While running, `configure' prints some messages telling which
  25.      features is it checking for. 
  26.  
  27.   2. Compile the package by typing:
  28.         % make
  29.      Running `make' takes a while. If this is a very large package, now
  30.      is the time to go make some coffee.
  31.      
  32.   3. Some packages are bundled with self-tests for source-code 
  33.      verification. If this package includes such tests, you can 
  34.      optionally run them after compilation by typing 
  35.         % make check
  36.  
  37.   4. Type `make install' to install the programs and any data files and
  38.      documentation. Type `make uninstall' to undo the installation.
  39.      During installation, the following files go to the following directories:
  40.         Executables          -> /prefix/bin
  41.         docs and samples     -> /prefix/share/doc/source-highlight
  42.         conf files           -> /prefix/share/source-highlight
  43.      where `prefix' is either `/usr/local' or the PATH that you specified
  44.      in the `--prefix' flag.
  45.  
  46.      If any of these directories do not presently exist, they will be
  47.      created on demand. 
  48.  
  49.      If you are installing in your home directory make sure that 
  50.      `/home/luser/bin' is in your path. If you're using the bash shell
  51.      add this line at the end of your .cshrc file:
  52.         PATH="/home/luser/bin:${PATH}"
  53.         export PATH
  54.      If you are using csh or tcsh, then use this line instead:
  55.         setenv PATH /home/luser/bin:${PATH}
  56.      By prepending your home directory to the rest of the PATH you can
  57.      override systemwide installed software with your own custom installation.
  58.  
  59.   5. You can remove the program binaries and object files from the
  60.      source code directory by typing `make clean'.  To also remove the
  61.      files that `configure' created (so you can compile the package for
  62.      a different kind of computer), type `make distclean'.
  63.  
  64. Problems
  65. ========
  66.    You shouldn't get any problem, because configure should succeed in
  67. finding everything you need, but some Unix systems may not have some
  68. right settings, especially for C++ directories: one problem encountered
  69. was on a Sparc: C++ couldn't find include files (such as iostream.h).
  70. You'll just have to search for one of them (e.g iostream.h) 
  71. and then assign that directory to INCLUDE env.var specifying -I option,
  72. e.g. if include files are in the directory /usr/include/g++-include, type
  73.  
  74.   export INCLUDE=-I/usr/include/g++-include
  75.  
  76. under bash shell or
  77.  
  78.   setenv INCLUDE -I/usr/include/g++-include
  79.  
  80. and run configure once again.
  81.   For instance on that Sparc the directory was 
  82. /export/opt/FSFlibg++/lib/g++-include !!! 
  83.  
  84.   If this doesn't work, please mail me your problem at 
  85. bug-source-highlight@gnu.org.
  86.  
  87. Compiler configuration
  88. ======================
  89.  
  90.    The `configure' shell script is responsible for choosing and configuring
  91. the compiler(s). 
  92.  
  93. The following options allow you to specify whether you
  94. want to enable or disable various debugging mechanisms:
  95.  
  96. `--enable-warnings'
  97.       Make the compilers very picky about warnings. Try this whenever you
  98.       write new code since it may catch a few bugs. This is not active by
  99.       default because all too often warnings can be too picky and scare
  100.       the end-user.
  101.  
  102. `--enable-input-chroot'
  103.       hardcode in the program the path to prepend for input files.
  104.       Useful when the programs are built for CGI, in order to hide,
  105.       in the html page, the real structure of the server file system.
  106.  
  107. All programs are compiled with optimization level 2 by default (-O2).
  108. Occasionally that confuses the debugger when code is inlined. To disable
  109. optimization and enable debugging, set the shell environment variables
  110. CFLAGS, CXXFLAGS, FFLAGS to `-g'. On the bash shell, you can do this
  111. like this:
  112.   $ export CFLAGS="-g"
  113.   $ export CXXFLAGS="-g"
  114.   $ export FFLAGS="-g"
  115. On the tcsh shell, use the `setenv' command instead:
  116.   % setenv CFLAGS "-g"
  117.   ...etc...
  118. For other shell, please consult your shell's documentation.
  119.  
  120. Similarly, you can increase the optimization level by assigning these
  121. variables to "-g -O3". 
  122.  
  123. Depending on what languages the package uses, some of these options may
  124. or may not be available. To see what is available, type:
  125.     % sh ./configure --help
  126.  
  127. About the configure script
  128. ==========================
  129.  
  130.    The `configure' shell script attempts to guess correct values for
  131. various system-dependent variables used during compilation.  It uses
  132. those values to create a `Makefile' in each directory of the package.
  133. It may also create one or more `.h' files containing system-dependent
  134. definitions.  Finally, it creates a shell script `config.status' that
  135. you can run in the future to recreate the current configuration, a file
  136. `config.cache' that saves the results of its tests to speed up
  137. reconfiguring, and a file `config.log' containing compiler output
  138. (useful mainly for debugging `configure').
  139.  
  140.    If you need to do unusual things to compile the package, please try
  141. to figure out how `configure' could check whether to do them, and mail
  142. diffs or instructions to the address given in the `README' so they can
  143. be considered for the next release.  If at some point `config.cache'
  144. contains results you don't want to keep, you may remove or edit it.
  145.  
  146.    The file `configure.in' is used to create `configure' by a program
  147. called `autoconf'.  You only need `configure.in' if you want to change
  148. it or regenerate `configure' using a newer version of `autoconf'.
  149.  
  150. Advanced installation options.
  151. ==============================
  152.  
  153.    The `configure' script also understands the following more advanced
  154. options, to handle situations for which `--prefix' alone is not sufficient.
  155.  
  156.    You can specify separate installation prefixes for
  157. architecture-specific files and architecture-independent files.  If you
  158. give `configure' the option `--exec-prefix=PATH', the package will use
  159. PATH as the prefix for installing programs and libraries.
  160. Documentation and other data files will still use the regular prefix.
  161.  
  162.    In addition, if you use an unusual directory layout you can give
  163. options like `--bindir=PATH' to specify different values for particular
  164. kinds of files.  Run `configure --help' for a list of the directories
  165. you can set and what kinds of files go in them.
  166.  
  167.    If the package supports it, you can cause programs to be installed
  168. with an extra prefix or suffix on their names by giving `configure' the
  169. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  170.  
  171. Optional Features
  172. =================
  173.  
  174.    Some packages pay attention to `--enable-FEATURE' options to
  175. `configure', where FEATURE indicates an optional part of the package.
  176. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  177. is something like `gnu-as' or `x' (for the X Window System).  The
  178. `README' should mention any `--enable-' and `--with-' options that the
  179. package recognizes.
  180.  
  181.    For packages that use the X Window System, `configure' can usually
  182. find the X include and library files automatically, but if it doesn't,
  183. you can use the `configure' options `--x-includes=DIR' and
  184. `--x-libraries=DIR' to specify their locations.
  185.  
  186. --------------------
  187.  
  188. Please send all bug reports by electronic mail to:
  189. bug-source-highlight@gnu.org
  190.  
  191. My home page is
  192. http://www.lorenzobettini.it
  193.  
  194. source-highlight is free GPL software. 
  195. See the file COPYING for copying conditions.
  196. Anyway I won't get offended if you send me a postcard :-)
  197.